home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 2: CDPD 1 / Almathera Ten on Ten - Disc 2: CDPD 1.iso / kingfisher / fisher / fisher.doc next >
Text File  |  1995-03-20  |  7KB  |  212 lines
  1.  ---------------------------------------------------------------------------
  2.  
  3.                                 Fisher.rexx
  4.               ARexx/DLG Front End for the KingFisher Database.
  5.                       Copyright © 1994 Keith R. Burby
  6.                             [User Documentation]
  7.  
  8.  ---------------------------------------------------------------------------
  9.  
  10.  
  11. Legal Stuff
  12. ~~~~~~~~~~~
  13. The Fisher.rexx script and the documentation are copyrighted by the author.
  14. Feel free to make changes, to this program,to suit your needs, however, I
  15. ask two things:  1) If you feel that the changes you've made, to this
  16. program, are improvements or bug fixes, please send me a copy of the updated
  17. script with some notes regarding the changes you made.  2) Do not alter the
  18. program's title, in particular, the two lines which give credit to both
  19. myself and Mr. Shuermann.
  20.  
  21. The author accepts no responsibility for any damage to the system of anyone
  22. who uses this program.
  23. USE THIS PROGRAM AT YOUR OWN RISK.
  24.  
  25.  
  26. Usage
  27. ~~~~~
  28. Fisher.rexx is divided up into three separate menus:  The main menu, the
  29. search menu, and the request menu.
  30.  
  31.  
  32.   Main Menu
  33.   ~~~~~~~~~
  34.   This is where most of the work will be done.  This is also where the
  35.   description of the titles can be seen.  The commands are as follows:
  36.  
  37.     F) First Entry
  38.  
  39.       Move the entry pointer to the very first entry in the database.
  40.  
  41.     L) Last Entry
  42.  
  43.       Move the entry pointer to the very last entry in the database.
  44.  
  45.     P) Previous Entry
  46.  
  47.       Move the pointer to the previous entry.  This will have no effect if
  48.       you are already at the first entry.
  49.  
  50.     N) Next Entry
  51.  
  52.       Move the pointer to the next entry.  This will have no effect if you
  53.       are already at the last entry.
  54.  
  55.     -) Previous Disk
  56.  
  57.       Move to the first entry of the previous disk.  This will have no
  58.       effect if you are already at the first disk.
  59.  
  60.     +) Next Disk
  61.  
  62.       Move to the first entry of the next disk.  This will have no effect if
  63.       you are already at the last disk.
  64.  
  65.     <) Previous Version
  66.  
  67.       Move to an entry which is an older version of the current title.
  68.       This will have no effect if there are no earlier versions of this
  69.       title.
  70.  
  71.     >) Next Version
  72.  
  73.       Move to an entry which is a newer version of the current title.  This
  74.       will have no effect if there are no newer versions of this title.
  75.  
  76.     S) Begin Search
  77.  
  78.       Bring up the search menu.
  79.  
  80.     C) Continue Search
  81.  
  82.       Continue a previously set up search.  This will have no effect if you
  83.       haven't initiated a search earlier.
  84.  
  85.     R) Make Request
  86.  
  87.       Bring up the request menu.  Note:  depending on how the sysop has this
  88.       script configured, this option may not be available.
  89.  
  90.     Q) Quit Fisher.
  91.  
  92.       The name says it all.
  93.  
  94.   If you enter a number, within the range of 1 and the last disk in the
  95.   database, the pointer will be moved to the first entry of the specified
  96.   disk.  (i.e. entering 820 will move you to "Databench", the first entry of
  97.   disk #820)
  98.  
  99.   If you enter a NEGATIVE number, within the range of 1 and the last entry
  100.   in the database, the pointer will be moved to that entry.  (i.e. entering
  101.   -926, you will be moved to "GlobeDemo", found on disk #151)
  102.  
  103.   Pressing return, without entering anything, will toggle the display
  104.   between the menu listing and the description of the current title.  Note
  105.   that all of the commands will still be available even when the description
  106.   is displayed.
  107.  
  108.  
  109.   Search Menu
  110.   ~~~~~~~~~~~
  111.   When you first invoke the search menu, you'll be presented with the
  112.   following list of defaults:
  113.  
  114.     Search mode will be set to TITLE search
  115.     Search direction will be set to BACKWARDS
  116.     Search range will be set to DISABLED (from the current entry to the 1st)
  117.     Case sensitivity will be set to IGNORED (case insensitive)
  118.     The search string will be empty ("")
  119.  
  120.   The menu entries are as follows:
  121.  
  122.     M) Change Mode
  123.  
  124.       This will switch the search mode between TITLE and DESCRIPTION.  A
  125.       TITLE search will search through only the entry titles for the
  126.       specified pattern, while a DESCRIPTION search will search through both
  127.       the titles and descriptions for the specified pattern.  Needless to
  128.       say, a TITLE search is much faster than a DESCRIPTION search.
  129.  
  130.     D) Change Direction
  131.  
  132.       This will switch the direction between BACKWARD and FORWARD.  A
  133.       BACKWARD search will search the database from the current entry to the
  134.       first entry, while a FORWARD search will search from the current entry
  135.       to the last.
  136.  
  137.     R) Change Range
  138.  
  139.       This entry does two things.  If the range is currently DISABLED, you
  140.       will be prompted to enter the lowest disk number and highest disk
  141.       number you want to conduct the search though.  If a range is already
  142.       specified this option will clear and disable the search range.
  143.  
  144.       NOTE:  If you have specified a range, and your current disk number is
  145.       higher than the high range (for a FORWARD search) or lower than the
  146.       low range (for a BACKWARD search), the search will abort.
  147.  
  148.     C) Change Case
  149.  
  150.       This will change the case sensitivity between IGNORED (a = A) and
  151.       SENSITIVE (a <> A).  Most likely, you'll never have to fool with this
  152.       option.
  153.  
  154.     S) Change String
  155.  
  156.       After selecting this option, you will be prompted to enter the
  157.       string/pattern you wish to search for.  The search string can include
  158.       any AmigaDOS pattern matching characters, including #? and possibly *,
  159.       with the additional character & to represent a logical AND.
  160.  
  161.     B) Begin search
  162.  
  163.       Name says it all.
  164.  
  165.     Q) Quit search menu
  166.  
  167.       Ditto.
  168.  
  169.   If you have specified a range, and the disk pointer is currently at a disk
  170.   below the specified range (for a BACKWARD search) or above the specified
  171.   range (for a FORWARD search), the search will abort.  If the disk pointer
  172.   is above the range (for a BACKWARD search) or below the range (for a
  173.   FORWARD search) the disk pointer will be moved to the high range or low
  174.   range respectively.
  175.  
  176.   In order for a search to be initiated, a search string must be provided,
  177.   otherwise the B) Begin Search option and the C) Continue Search option,
  178.   found on the main menu, will not operate.
  179.  
  180.  
  181.   Request Menu
  182.   ~~~~~~~~~~~~
  183.   This menu will allow the user to make a request for either a specific
  184.   title and which Fish disk it can be found on, or an entire disk.
  185.  
  186.   The menu entries are as follows:
  187.  
  188.     S) Current selection
  189.  
  190.       The sysop will receive E-mail stating that you requested a copy of the
  191.       title currently displayed and the disk it can be found on.
  192.  
  193.     D) Entire disk
  194.  
  195.       The sysop will receive E-mail stating that you have requested a copy
  196.       of the Fish Disk currently being displayed.
  197.  
  198.     Q) Quit (Don't send request)
  199.  
  200.       Name says it all.
  201.  
  202.   Again, depending upon how the sysop has this script configured, this
  203.   menu may or may not be available.
  204.  
  205.  
  206. I hope you enjoy the program.  I know I had fun writing it.
  207.  
  208. As always.
  209.  
  210.                                                   K/B
  211.                                                   ~~~
  212.